/*! \file bcmtm_tdm_top.h
 *
 * Top header for TDM algorithm.
 */
/*
 * Copyright: (c) 2018 Broadcom. All Rights Reserved. "Broadcom" refers to 
 * Broadcom Limited and/or its subsidiaries.
 * 
 * Broadcom Switch Software License
 * 
 * This license governs the use of the accompanying Broadcom software. Your 
 * use of the software indicates your acceptance of the terms and conditions 
 * of this license. If you do not agree to the terms and conditions of this 
 * license, do not use the software.
 * 1. Definitions
 *    "Licensor" means any person or entity that distributes its Work.
 *    "Software" means the original work of authorship made available under 
 *    this license.
 *    "Work" means the Software and any additions to or derivative works of 
 *    the Software that are made available under this license.
 *    The terms "reproduce," "reproduction," "derivative works," and 
 *    "distribution" have the meaning as provided under U.S. copyright law.
 *    Works, including the Software, are "made available" under this license 
 *    by including in or with the Work either (a) a copyright notice 
 *    referencing the applicability of this license to the Work, or (b) a copy 
 *    of this license.
 * 2. Grant of Copyright License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    copyright license to reproduce, prepare derivative works of, publicly 
 *    display, publicly perform, sublicense and distribute its Work and any 
 *    resulting derivative works in any form.
 * 3. Grant of Patent License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    patent license to make, have made, use, offer to sell, sell, import, and 
 *    otherwise transfer its Work, in whole or in part. This patent license 
 *    applies only to the patent claims licensable by Licensor that would be 
 *    infringed by Licensor's Work (or portion thereof) individually and 
 *    excluding any combinations with any other materials or technology.
 *    If you institute patent litigation against any Licensor (including a 
 *    cross-claim or counterclaim in a lawsuit) to enforce any patents that 
 *    you allege are infringed by any Work, then your patent license from such 
 *    Licensor to the Work shall terminate as of the date such litigation is 
 *    filed.
 * 4. Redistribution
 *    You may reproduce or distribute the Work only if (a) you do so under 
 *    this License, (b) you include a complete copy of this License with your 
 *    distribution, and (c) you retain without modification any copyright, 
 *    patent, trademark, or attribution notices that are present in the Work.
 * 5. Derivative Works
 *    You may specify that additional or different terms apply to the use, 
 *    reproduction, and distribution of your derivative works of the Work 
 *    ("Your Terms") only if (a) Your Terms provide that the limitations of 
 *    Section 7 apply to your derivative works, and (b) you identify the 
 *    specific derivative works that are subject to Your Terms. 
 *    Notwithstanding Your Terms, this license (including the redistribution 
 *    requirements in Section 4) will continue to apply to the Work itself.
 * 6. Trademarks
 *    This license does not grant any rights to use any Licensor's or its 
 *    affiliates' names, logos, or trademarks, except as necessary to 
 *    reproduce the notices described in this license.
 * 7. Limitations
 *    Platform. The Work and any derivative works thereof may only be used, or 
 *    intended for use, with a Broadcom switch integrated circuit.
 *    No Reverse Engineering. You will not use the Work to disassemble, 
 *    reverse engineer, decompile, or attempt to ascertain the underlying 
 *    technology of a Broadcom switch integrated circuit.
 * 8. Termination
 *    If you violate any term of this license, then your rights under this 
 *    license (including the license grants of Sections 2 and 3) will 
 *    terminate immediately.
 * 9. Disclaimer of Warranty
 *    THE WORK IS PROVIDED "AS IS" WITHOUT WARRANTIES OR CONDITIONS OF ANY 
 *    KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WARRANTIES OR CONDITIONS OF 
 *    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR 
 *    NON-INFRINGEMENT. YOU BEAR THE RISK OF UNDERTAKING ANY ACTIVITIES UNDER 
 *    THIS LICENSE. SOME STATES' CONSUMER LAWS DO NOT ALLOW EXCLUSION OF AN 
 *    IMPLIED WARRANTY, SO THIS DISCLAIMER MAY NOT APPLY TO YOU.
 * 10. Limitation of Liability
 *    EXCEPT AS PROHIBITED BY APPLICABLE LAW, IN NO EVENT AND UNDER NO LEGAL 
 *    THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE 
 *    SHALL ANY LICENSOR BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, 
 *    INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF 
 *    OR RELATED TO THIS LICENSE, THE USE OR INABILITY TO USE THE WORK 
 *    (INCLUDING BUT NOT LIMITED TO LOSS OF GOODWILL, BUSINESS INTERRUPTION, 
 *    LOST PROFITS OR DATA, COMPUTER FAILURE OR MALFUNCTION, OR ANY OTHER 
 *    COMMERCIAL DAMAGES OR LOSSES), EVEN IF THE LICENSOR HAS BEEN ADVISED OF 
 *    THE POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef BCMTM_TDM_TOP_H
#define BCMTM_TDM_TOP_H

#ifdef _TDM_STANDALONE
    /*! General headers. */
    #include <alloca.h>
    #include <stdio.h>
    #include <stdlib.h>
    #include <string.h>
    /*! TDM prints. */
    #define TDM_LOG_NORMAL(...)           \
                printf(__VA_ARGS__)
    #define TDM_LOG_WARN(...)             \
                printf("TDM WARN:  ");    \
                printf(__VA_ARGS__)
    #define TDM_LOG_ERROR(...)            \
                printf("TDM ERROR:  ");   \
                printf(__VA_ARGS__)

    #define TDM_PRINT8(a,b,c,d,e,f,g,h,i) TDM_LOG_NORMAL(a,b,c,d,e,f,g,h,i)
    #define TDM_PRINT7(a,b,c,d,e,f,g,h) TDM_LOG_NORMAL(a,b,c,d,e,f,g,h)
    #define TDM_PRINT6(a,b,c,d,e,f,g) TDM_LOG_NORMAL(a,b,c,d,e,f,g)
    #define TDM_PRINT5(a,b,c,d,e,f) TDM_LOG_NORMAL(a,b,c,d,e,f)
    #define TDM_PRINT4(a,b,c,d,e) TDM_LOG_NORMAL(a,b,c,d,e)
    #define TDM_PRINT3(a,b,c,d) TDM_LOG_NORMAL(a,b,c,d)
    #define TDM_PRINT2(a,b,c) TDM_LOG_NORMAL(a,b,c)
    #define TDM_PRINT1(a,b) TDM_LOG_NORMAL(a,b)
    #define TDM_PRINT0(a) TDM_LOG_NORMAL(a)

    #define TDM_WARN8(a,b,c,d,e,f,g,h,i) TDM_LOG_WARN(a,b,c,d,e,f,g,h,i)
    #define TDM_WARN7(a,b,c,d,e,f,g,h) TDM_LOG_WARN(a,b,c,d,e,f,g,h)
    #define TDM_WARN6(a,b,c,d,e,f,g) TDM_LOG_WARN(a,b,c,d,e,f,g)
    #define TDM_WARN5(a,b,c,d,e,f) TDM_LOG_WARN(a,b,c,d,e,f)
    #define TDM_WARN4(a,b,c,d,e) TDM_LOG_WARN(a,b,c,d,e)
    #define TDM_WARN3(a,b,c,d) TDM_LOG_WARN(a,b,c,d)
    #define TDM_WARN2(a,b,c) TDM_LOG_WARN(a,b,c)
    #define TDM_WARN1(a,b) TDM_LOG_WARN(a,b)
    #define TDM_WARN0(a) TDM_LOG_WARN(a)

    #define TDM_ERROR8(a,b,c,d,e,f,g,h,i) TDM_LOG_ERROR(a,b,c,d,e,f,g,h,i)
    #define TDM_ERROR7(a,b,c,d,e,f,g,h) TDM_LOG_ERROR(a,b,c,d,e,f,g,h)
    #define TDM_ERROR6(a,b,c,d,e,f,g) TDM_LOG_ERROR(a,b,c,d,e,f,g)
    #define TDM_ERROR5(a,b,c,d,e,f) TDM_LOG_ERROR(a,b,c,d,e,f)
    #define TDM_ERROR4(a,b,c,d,e) TDM_LOG_ERROR(a,b,c,d,e)
    #define TDM_ERROR3(a,b,c,d) TDM_LOG_ERROR(a,b,c,d)
    #define TDM_ERROR2(a,b,c) TDM_LOG_ERROR(a,b,c)
    #define TDM_ERROR1(a,b) TDM_LOG_ERROR(a,b)
    #define TDM_ERROR0(a) TDM_LOG_ERROR(a)

    #define TDM_BIG_BAR TDM_LOG_NORMAL("TDM: %s\n", \
        "##################################################################");
    #define TDM_SML_BAR TDM_LOG_NORMAL("TDM: %s\n", \
        "------------------------------------------------------------------");
    /*! Compiler memory ops. */
    #define TDM_EXTERN extern
    #define TDM_ALLOC(_sz,_id) malloc(_sz)
    #define TDM_FREE(_sz) free(_sz)
    #define TDM_MEMSET(_addr,_val,_len) memset(_addr, _val, _len)
    #define TDM_MEMCPY(_dst,_src,_len) memcpy(_dst,_src,_len)
    #define TDM_ARRSET(_addr, _val, _len)                   \
                    {                                       \
                        int idx;                            \
                        for (idx = 0; idx < _len; idx++) {  \
                            _addr[idx] = _val;              \
                        }                                   \
                    }
    /*! TDM headers. */
    #include <bcmtm_tdm_defines.h>
    #include <bcmtm_tdm_misc.h>
    #include <bcmtm_tdm_sched.h>
    #include <bcmtm_tdm_cfg.h>
    #include <bcmtm_tdm_drv.h>
#else
    /*! General headers. */
    #include <bsl/bsl.h>
    #include <sal/sal_alloc.h>
    #include <sal/sal_libc.h>

    #ifndef BSL_LS_SOC_TDM
    #define BSL_LS_SOC_TDM   BSL_LS_BCMTM_TMMGR
    #endif
    #ifndef BSL_LS_SOC_PORT
    #define BSL_LS_SOC_PORT  BSL_LS_BCMTM_TMMGR
    #endif

    /*! TDM prints. */
    #define TDM_PRINT8(a,b,c,d,e,f,g,h,i) \
            LOG_VERBOSE(BSL_LS_SOC_TDM, (BSL_META(a),b,c,d,e,f,g,h,i))
    #define TDM_PRINT7(a,b,c,d,e,f,g,h)   \
            LOG_VERBOSE(BSL_LS_SOC_TDM, (BSL_META(a),b,c,d,e,f,g,h))
    #define TDM_PRINT6(a,b,c,d,e,f,g)     \
            LOG_VERBOSE(BSL_LS_SOC_TDM, (BSL_META(a),b,c,d,e,f,g))
    #define TDM_PRINT5(a,b,c,d,e,f)       \
            LOG_VERBOSE(BSL_LS_SOC_TDM, (BSL_META(a),b,c,d,e,f))
    #define TDM_PRINT4(a,b,c,d,e)         \
            LOG_VERBOSE(BSL_LS_SOC_TDM, (BSL_META(a),b,c,d,e))
    #define TDM_PRINT3(a,b,c,d)           \
            LOG_VERBOSE(BSL_LS_SOC_TDM, (BSL_META(a),b,c,d))
    #define TDM_PRINT2(a,b,c)             \
            LOG_VERBOSE(BSL_LS_SOC_TDM, (BSL_META(a),b,c))
    #define TDM_PRINT1(a,b)               \
            LOG_VERBOSE(BSL_LS_SOC_TDM, (BSL_META(a),b))
    #define TDM_PRINT0(a)                 \
            LOG_VERBOSE(BSL_LS_SOC_TDM, (BSL_META("%s"),a))

    #define TDM_WARN6(a,b,c,d,e,f,g)      \
                LOG_WARN(BSL_LS_SOC_TDM, (BSL_META(a),b,c,d,e,f,g))
    #define TDM_WARN5(a,b,c,d,e,f)        \
                LOG_WARN(BSL_LS_SOC_TDM, (BSL_META(a),b,c,d,e,f))
    #define TDM_WARN4(a,b,c,d,e)          \
                LOG_WARN(BSL_LS_SOC_TDM, (BSL_META(a),b,c,d,e))
    #define TDM_WARN3(a,b,c,d)            \
                LOG_WARN(BSL_LS_SOC_TDM, (BSL_META(a),b,c,d))
    #define TDM_WARN2(a,b,c)              \
                LOG_WARN(BSL_LS_SOC_TDM, (BSL_META(a),b,c))
    #define TDM_WARN1(a,b)                \
                LOG_WARN(BSL_LS_SOC_TDM, (BSL_META(a),b))
    #define TDM_WARN0(a)                  \
                LOG_WARN(BSL_LS_SOC_TDM, (BSL_META("%s"),a))

    #define TDM_ERROR8(a,b,c,d,e,f,g,h,i) \
                LOG_ERROR(BSL_LS_SOC_TDM, (BSL_META(a),b,c,d,e,f,g,h,i))
    #define TDM_ERROR7(a,b,c,d,e,f,g,h)   \
                LOG_ERROR(BSL_LS_SOC_TDM, (BSL_META(a),b,c,d,e,f,g,h))
    #define TDM_ERROR6(a,b,c,d,e,f,g)     \
                LOG_ERROR(BSL_LS_SOC_TDM, (BSL_META(a),b,c,d,e,f,g))
    #define TDM_ERROR5(a,b,c,d,e,f)       \
                LOG_ERROR(BSL_LS_SOC_TDM, (BSL_META(a),b,c,d,e,f))
    #define TDM_ERROR4(a,b,c,d,e)         \
                LOG_ERROR(BSL_LS_SOC_TDM, (BSL_META(a),b,c,d,e))
    #define TDM_ERROR3(a,b,c,d)           \
                LOG_ERROR(BSL_LS_SOC_TDM, (BSL_META(a),b,c,d))
    #define TDM_ERROR2(a,b,c)             \
                LOG_ERROR(BSL_LS_SOC_TDM, (BSL_META(a),b,c))
    #define TDM_ERROR1(a,b)               \
                LOG_ERROR(BSL_LS_SOC_TDM, (BSL_META(a),b))
    #define TDM_ERROR0(a)                 \
                LOG_ERROR(BSL_LS_SOC_TDM, (BSL_META(a)))

    #define TDM_BIG_BAR TDM_PRINT1("TDM: %s\n", \
        "##################################################################");
    #define TDM_SML_BAR TDM_PRINT1("TDM: %s\n", \
        "------------------------------------------------------------------");
    /*! Compiler memory ops. */
    #define TDM_EXTERN
    #define TDM_ALLOC(_sz,_id) sal_alloc(_sz,_id)
    #define TDM_FREE(_sz) sal_free(_sz)
    #define TDM_MEMSET(_addr,_val,_len) sal_memset(_addr, _val, _len)
    #define TDM_MEMCPY(_dst,_src,_len) sal_memcpy(_dst,_src,_len)
    #define TDM_ARRSET(_addr, _val, _len)                   \
                    {                                       \
                        int idx;                            \
                        for (idx = 0; idx < _len; idx++) {  \
                            _addr[idx] = _val;              \
                        }                                   \
                    }
    /*! TDM headers. */
    #include <bcmtm/tdm/bcmtm_tdm_defines.h>
    #include <bcmtm/tdm/bcmtm_tdm_misc.h>
    #include <bcmtm/tdm/bcmtm_tdm_sched.h>
    #include <bcmtm/tdm/bcmtm_tdm_cfg.h>
    #include <bcmtm/tdm/bcmtm_tdm_drv.h>
#endif

#endif /* BCMTM_TDM_TOP_H */
